CRPEJob::GetGroupCondition
Use GetGroupCondition to retrieve the group condition information for a selected group section in the specified report. Use this method to find out the group condition for a group section. Use CRPEJob::SetGroupCondition, to change the group condition once it is known.
Syntax
GetGroupCondition (sectionCode SMALLINT) RETURNING BOOLEAN, ixString,
SMALLINT, SMALLINT
Parameter
sectionCode
| Specifies the Section Codes, for the section of the report for which you want to retrieve group condition information.
|
Returns
Boolean
- TRUE if the call is successful.
- FALSE if the call fails.
A ixString object containing the name of the group summary field.
A group condition field type constant which can be decoded using one of the following masks to separate the condition type from the group condition in the condition parameter.
- PEP_GC_CONDITIONMASK: Obtains the group condition value. Use the bitwise AND (&) to combine this mask with the value of the condition parameter to obtain the group condition value.
- PEP_GC_TYPEMASK: Obtains the type of field used for the group condition. Use the bitwise AND (&) to combine this mask with the value of the condition parameter to obtain a value representing the type of field used by the group condition.
A Sort Order Constants.
Remarks
For group condition field types other than Date and Boolean, the group condition value of the condition parameter is PEP_GC_ANYCHANGE.
Value (Date Fields)
| Meaning
|
PEP_GC_DAILY
| Triggers a grouping every time the date changes.
|
PEP_GC_WEEKLY
| Triggers a grouping every time the date changes from one week to the next (a week runs from Sunday through Saturday).
|
PEP_GC_BIWEEKLY
| Triggers a grouping every time the date changes from one two-week period to the next.
|
PEP_GC_SEMIMONTHLY
| Triggers a grouping every time the date changes from one half-month period to the next.
|
PEP_GC_MONTHLY
| Triggers a grouping every time the date changes from one month to the next.
|
PEP_GC_QUARTERLY
| Triggers a grouping every time the date changes from one calendar quarter to the next.
|
PEP_GC_SEMIANNUALLY
| Triggers a grouping every time the date changes from one half-year period to the next.
|
PEP_GC_ANNUALLY
| Triggers a grouping every time the date changes from one year to the next.
|
Value (Boolean Fields)
| Meaning
|
PEP_GC_TOYES
| Triggers a grouping every time the sort and group by field changes from No to Yes.
|
PEP_GC_TONO
| Triggers a grouping every time the sort and group by field changes from Yes to No.
|
PEP_GC_EVERYYES
| Triggers a grouping every time the group and sort by field value is Yes.
|
PEP_GC_EVERYNO
| Triggers a grouping every time the group and sort by field value is No.
|
PEP_GC_NEXTISYES
| Triggers a grouping every time the next value in the sort and group by field is Yes.
|
PEP_GC_NEXTISNO
| Triggers a grouping every time the next value in the sort and group by field is No.
|
The group condition field type portion of the condition parameter will be one of the following values:
Value
| Meaning
|
PEP_GC_TYPEOTHER
| Any field type other than Date or Boolean. The group condition portion of the condition parameter will be PEP_GC_ANYCHANGE.
|
PEP_GC_TYPEDATE
| A Date field is used to create the group summary field.
|
PEP_GC_TYPEBOOLEAN
| A Boolean field is used to create the group summary field.
|
Related Topics
PEGetGroupCondition